Implement HW/SW crypto affinity by AlexLanzano · Pull Request #281 · wolfSSL/wolfHSM

AlexLanzano · 2026-02-04T21:22:32Z

Add SetCryptoAffinity API for runtime HW/SW crypto selection

Summary

This PR adds a new client API to dynamically switch between hardware and software cryptographic implementations at runtime. This allows clients to control whether the server uses crypto callbacks (hardware acceleration) or pure software wolfCrypt implementations.

Changes

New Client API (wh_client.c, wh_client.h)
- wh_Client_SetCryptoAffinity() - blocking call
- wh_Client_SetCryptoAffinityRequest() / wh_Client_SetCryptoAffinityResponse() - async API
New Message Types (wh_message_comm.c, wh_message_comm.h)
- WH_MESSAGE_COMM_ACTION_SET_CRYPTO_AFFINITY action
- WH_CRYPTO_AFFINITY_SW / WH_CRYPTO_AFFINITY_HW enum values
- Request/response structures with translation functions
Server Handler (wh_server.c, wh_server.h)
- Added configDevId field to preserve the original configured device ID
- Handler switches devId between INVALID_DEVID (SW) and configDevId (HW)
Tests (wh_test_clientserver.c)
- Added _testCryptoAffinity() to verify SW/HW switching behavior
Documentation (docs/draft/crypto_affinity.md)
- API usage guide with examples

Usage

int32_t server_rc;
uint32_t affinity;

// Switch to software crypto
wh_Client_SetCryptoAffinity(client, WH_CRYPTO_AFFINITY_SW, &server_rc, &affinity);

// Switch to hardware crypto (if configured)
wh_Client_SetCryptoAffinity(client, WH_CRYPTO_AFFINITY_HW, &server_rc, &affinity);

Copilot

Pull request overview

This PR implements a new client API to dynamically switch between hardware and software cryptographic implementations at runtime. The feature allows clients to control whether the server uses hardware acceleration (via crypto callbacks) or pure software wolfCrypt implementations by modifying the server's devId field.

Changes:

New client API with both blocking and async variants for setting crypto affinity
Server handler to process affinity change requests with proper validation and error handling
New message types and translation functions for client-server communication
Comprehensive test coverage including edge cases and error conditions

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
wolfhsm/wh_server.h	Added `configDevId` field to preserve original device ID configuration
wolfhsm/wh_message_comm.h	Defined message action, enum values, and request/response structures
wolfhsm/wh_error.h	Added `WH_ERROR_BADCONFIG` error code for configuration failures
wolfhsm/wh_client.h	Declared new client API functions with comprehensive documentation
src/wh_server.c	Implemented initialization of `configDevId` and request handler with validation
src/wh_message_comm.c	Implemented message translation functions following existing patterns
src/wh_client.c	Implemented client APIs with proper error handling and retry logic
test/wh_test_clientserver.c	Added comprehensive test coverage for various scenarios
docs/draft/crypto_affinity.md	Created API documentation with usage examples and return code reference

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

test/wh_test_clientserver.c

docs/draft/crypto_affinity.md

Copilot

Pull request overview

Copilot reviewed 11 out of 12 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

test/wh_test_crypto_affinity.c

Copilot

Pull request overview

Copilot reviewed 11 out of 12 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

test/wh_test_crypto_affinity.c

wolfhsm/wh_message_comm.h

test/wh_test_crypto_affinity.h

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

bigbrett

Nice work. Some tweaks required and some deeper architectural questions.

docs/draft/crypto_affinity.md

wolfhsm/wh_client.h

src/wh_server.c

test/wh_test_crypto_affinity.c

src/wh_server.c

test/wh_test_crypto_affinity.c

src/wh_server.c

Copilot

Pull request overview

Copilot reviewed 29 out of 30 changed files in this pull request and generated 7 comments.

Comments suppressed due to low confidence (1)

wolfhsm/wh_server.h:72

Removing devId from whServerCryptoContext is an API/ABI breaking change for downstream users that initialize this public struct (previously .devId = INVALID_DEVID). If this is intentional, it should be called out in release notes/migration docs; otherwise consider providing a compatibility shim (e.g., keep the field behind a deprecated macro) to avoid breaking existing integrations.

#ifndef WOLFHSM_CFG_NO_CRYPTO

typedef struct whServerCryptoContext {
#ifndef WC_NO_RNG
    WC_RNG rng[1];
#endif
} whServerCryptoContext;

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/wh_server.c

examples/posix/wh_posix_server/wh_posix_server.c

docs/draft/crypto_affinity.md

docs/src/chapter03.md

docs/src-ja/chapter03.md

benchmark/wh_bench.c

bigbrett

@AlexLanzano looks awesome. Pls remove unnecessary include and run clang-format, then we are good.

bigbrett · 2026-03-05T17:49:23Z

wolfhsm/wh_client.h


 /* Component includes */
 #include "wolfhsm/wh_comm.h"
+#include "wolfhsm/wh_message_comm.h"


unnecessary include

bigbrett · 2026-03-05T17:49:41Z

wolfhsm/wh_server.h

    whCommServer  comm[1];
 #ifndef WOLFHSM_CFG_NO_CRYPTO
    whServerCryptoContext* crypto;
+    int                   defaultDevId;


run git-clang-format main and commit changes pls

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…ld to generic crypto header

…ity test to new aes cbc functions

Copilot

Pull request overview

Copilot reviewed 32 out of 32 changed files in this pull request and generated 5 comments.

Comments suppressed due to low confidence (1)

wolfhsm/wh_server.h:1

The field is named defaultDevId while the existing codebase consistently uses devId (e.g., whServerConfig.devId, crypto->devId). A more consistent name following the existing convention would be configDevId as mentioned in the PR description, or simply match the pattern used elsewhere. defaultDevId implies a fallback semantic that is not always accurate (e.g., it is also used directly for SHE and keystore operations regardless of affinity).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

docs/draft/crypto_affinity.md

test/wh_test_crypto_affinity.c

src/wh_client_crypto.c

src/wh_server_crypto.c

Copilot

Pull request overview

Copilot reviewed 32 out of 32 changed files in this pull request and generated 7 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

wolfhsm/wh_client_crypto.h

test/wh_test_crypto_affinity.c

wolfhsm/wh_server.h

src/wh_server_crypto.c

src/wh_client_crypto.c

wolfhsm/wh_server.h

src/wh_client_crypto.c

AlexLanzano requested a review from Copilot February 4, 2026 21:22

Copilot started reviewing on behalf of AlexLanzano February 4, 2026 21:23 View session

Copilot AI reviewed Feb 4, 2026

View reviewed changes

test/wh_test_clientserver.c Outdated Show resolved Hide resolved

test/wh_test_clientserver.c Outdated Show resolved Hide resolved

docs/draft/crypto_affinity.md Outdated Show resolved Hide resolved

AlexLanzano requested a review from Copilot February 4, 2026 22:11

AlexLanzano force-pushed the crypto-hw-sw-affinity branch from e3fe789 to 571a0c7 Compare February 4, 2026 22:15

Copilot started reviewing on behalf of AlexLanzano February 4, 2026 22:20 View session

Copilot AI reviewed Feb 4, 2026

View reviewed changes

test/wh_test_crypto_affinity.c Outdated Show resolved Hide resolved

test/wh_test_crypto_affinity.c Outdated Show resolved Hide resolved

AlexLanzano force-pushed the crypto-hw-sw-affinity branch from 571a0c7 to 3655e5c Compare February 4, 2026 22:39

AlexLanzano requested a review from Copilot February 5, 2026 15:15

Copilot started reviewing on behalf of AlexLanzano February 5, 2026 15:27 View session

Copilot AI reviewed Feb 5, 2026

View reviewed changes

test/wh_test_crypto_affinity.c Outdated Show resolved Hide resolved

wolfhsm/wh_message_comm.h Outdated Show resolved Hide resolved

test/wh_test_crypto_affinity.h Outdated Show resolved Hide resolved

AlexLanzano force-pushed the crypto-hw-sw-affinity branch from 9949065 to 506f420 Compare February 5, 2026 19:08

AlexLanzano requested a review from Copilot February 5, 2026 19:18

Copilot AI reviewed Feb 5, 2026

View reviewed changes

Copilot started reviewing on behalf of AlexLanzano February 5, 2026 19:59 View session

AlexLanzano marked this pull request as ready for review February 5, 2026 20:53

AlexLanzano assigned bigbrett Feb 5, 2026

AlexLanzano requested review from bigbrett and billphipps February 5, 2026 20:53

AlexLanzano assigned billphipps Feb 5, 2026

AlexLanzano force-pushed the crypto-hw-sw-affinity branch from f1de629 to 55fe3ab Compare February 5, 2026 21:04

bigbrett requested changes Feb 6, 2026

View reviewed changes

bigbrett marked this pull request as draft February 10, 2026 15:49

AlexLanzano force-pushed the crypto-hw-sw-affinity branch 3 times, most recently from d426556 to b109054 Compare February 10, 2026 19:31

AlexLanzano requested a review from Copilot February 10, 2026 19:39

Copilot started reviewing on behalf of AlexLanzano February 10, 2026 19:40 View session

Copilot AI reviewed Feb 10, 2026

View reviewed changes

AlexLanzano marked this pull request as ready for review February 10, 2026 19:53

AlexLanzano requested a review from bigbrett February 10, 2026 19:53

bigbrett requested changes Feb 10, 2026

View reviewed changes

benchmark/wh_bench.c Show resolved Hide resolved

bigbrett force-pushed the crypto-hw-sw-affinity branch from c72c40c to cbc3ea7 Compare February 18, 2026 00:14

AlexLanzano force-pushed the crypto-hw-sw-affinity branch 2 times, most recently from 14fa4e5 to 4de6b72 Compare February 21, 2026 04:09

AlexLanzano requested a review from bigbrett February 21, 2026 04:14

bigbrett requested changes Mar 5, 2026

View reviewed changes

AlexLanzano and others added 7 commits March 6, 2026 13:50

Implement HW/SW crypto affinity

31452b2

Address comments

9f9cce0

Move devId from crypto context into server context

ed4a670

Update docs/draft/crypto_affinity.md

61fe117

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Refactor to move crypto affinity state to client and add affinity fie…

d341955

…ld to generic crypto header

Implement request/response functions for aes cbc. Update crypto affin…

fecb52f

…ity test to new aes cbc functions

Address Brett's comments

78735dd

Copilot AI review requested due to automatic review settings March 6, 2026 18:52

AlexLanzano force-pushed the crypto-hw-sw-affinity branch from 4de6b72 to 78735dd Compare March 6, 2026 18:52

Copilot AI reviewed Mar 6, 2026

View reviewed changes

docs/draft/crypto_affinity.md Outdated Show resolved Hide resolved

test/wh_test_crypto_affinity.c Outdated Show resolved Hide resolved

src/wh_client_crypto.c Show resolved Hide resolved

src/wh_client_crypto.c Show resolved Hide resolved

src/wh_server_crypto.c Outdated Show resolved Hide resolved

Copilot started reviewing on behalf of AlexLanzano March 6, 2026 20:20 View session

rename defaultDevId back to devId. Address copilot comments

f45d111

Copilot AI review requested due to automatic review settings March 7, 2026 14:22

Copilot started reviewing on behalf of AlexLanzano March 7, 2026 14:23 View session

Fix SHE build

dcbe3db

Copilot AI reviewed Mar 7, 2026

View reviewed changes

Address copilot comments

a2e05f5

AlexLanzano requested a review from bigbrett March 7, 2026 15:48

Conversation

AlexLanzano commented Feb 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Add SetCryptoAffinity API for runtime HW/SW crypto selection

Summary

Changes

Usage

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

bigbrett left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bigbrett left a comment

Choose a reason for hiding this comment

Uh oh!

bigbrett Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

bigbrett Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

AlexLanzano commented Feb 4, 2026 •

edited

Loading